<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_axi4s_remap: Examples</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_axi4s_remap
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('example.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">Examples </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>You can refer to the below stated example applications for more details on how to use v_axi4s_remap driver.</p>
<h1><a class="anchor" id="ex1"></a>
main.c</h1>
<p>Contains an example on how to use the <a class="el" href="struct_x_v__axi4s__remap.html" title="Driver instance data. ">XV_axi4s_remap</a> driver directly. This example demonstrates the usage of AXI4S Remap IP.</p>
<p>For details, see main.c.</p>
<h1><a class="anchor" id="ex2"></a>
vaxi4s_remapper_example.tcl</h1>
<p>Contains a tcl file which automates the process of generating the downloadable bit &amp; elf files from the provided example xsa file.</p>
<p>Example application design source files (contained within "examples" folder) are tightly coupled with the v_axi4s_remap example design available in Vivado Catalogue. To run this tcl</p>
<ol type="1">
<li>Copy the exported example design xsa file in the "examples" directory of the driver</li>
<li>Launch the xsct terminal</li>
<li>cd into the examples directory</li>
<li>source the tcl file <div class="fragment"><div class="line">xsct%&gt;source vaxi4s_remapper_example.tcl </div>
</div><!-- fragment --></li>
<li>execute the script <div class="fragment"><div class="line">xsct%&gt;vaxi4s_remapper_example &lt;xsa_file_name.xsa&gt; </div>
</div><!-- fragment --></li>
</ol>
<p>Script will perform following operations</p>
<ol type="1">
<li>Create workspace</li>
<li>Create HW project</li>
<li>Create BSP</li>
<li>Create Application Project</li>
<li>Build BSP and Application Project</li>
</ol>
<p>After the process is complete required files will be available in </p>
<pre class="fragment">  bit file -&gt; vaxi4s_remapper_example.sdk/vaxi4s_remapper_example_hw_platform folder
  elf file -&gt; vaxi4s_remapper_example.sdk/vaxi4s_remapper_example_design/{Debug/Release} folder
</pre><p>When executed on the board the example application will perform following operations</p>
<ol type="1">
<li>Program Video Clock Generator to 1080p@60Hz</li>
<li>Program TPG0 &amp; Remap0 to 1080p@60Hz</li>
<li>Check for Video Lock and report the status (PASS/FAIL)on UART</li>
<li>Repeat Steps 1-3 for 4KP@30Hz and 4KP@60Hz</li>
</ol>
<dl class="section note"><dt>Note</dt><dd>Serial terminal baud rate should be set to 115200</dd></dl>
<p>For details, see vaxi4s_remapper_example.tcl. </p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
